/* Copyright (C) 2008  Romolo Camplani, Marco Fortunato, Marco Marelli, Guido Rota, Fabio A. Schreiber et al.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.dei.perla.parser.clauses;

import org.dei.perla.parser.util.Library;

/**
 * Definisce un campionamento periodico time-based (il campionamento avviene cioe' in corrispondenza di determinati istanti temporali).
 * E' possibile specificare piu' periodi di campionamento diversi, ognuno dei quali e' associato ad una particolare condizione
 */
public class SamplingTimeBased extends SamplingClause {
	
	/**
	 * Collezione ordinata di coppie (condizione, periodo di campionamento)
	 */
	private SamplingIfEveryList periods;
	
	/**
	 * L'operazione da svolgere se la frequenza di campionamento selezionata non e' supportata dal dispositivo
	 */
	private OnUnsupportedSampleRateOptions operation;

	/**
	 * Il tipo di refresh del periodo di campionamento
	 */
	private RefreshClause refreshClause;

	
	/**
	 * Il costruttore della classe
	 *
	 */
	public SamplingTimeBased() {
		this.periods = new SamplingIfEveryList();
	}	
	
	/**
	 * Restituisce la lista delle condizioni e dei periodi di campionamento ad esse associati
	 */
	public SamplingIfEveryList getPeriods() {
		return this.periods;
	}
	
	/**
	 * Restiuisce l'operazione da svolgere qualora la frequenza di campionamento selezionata non fosse supporata dal dispositivo
	 */
	public OnUnsupportedSampleRateOptions getOperation() {
		return operation;
	}

	/**
	 * Imposta l'operazione da svolgere qualora la frequenza di campionamento selezionata non fosse supportata dal dispositivo
	 */
	public void setOperation(OnUnsupportedSampleRateOptions operation) {
		this.operation = operation;
	}
	
	/**
	 * Restituisce il tipo di refresh del periodo di campionamento
	 */
	public RefreshClause getRefreshClause() {
		return this.refreshClause;
	}

	/**
	 * Imposta il tipo di refresh del periodo di campionamento
	 */
	public void setRefreshClause(RefreshClause refreshClause) {
		this.refreshClause = refreshClause;
	}
		
	/**
	 * Restituisce lo spezzone di codice "perla" corrispondente
	 */
	public String toString() {
		String stringToReturn1 = "";
		String stringToReturn2 = "";
		
		// Aggiunge la parola chiave samplings
		stringToReturn1 = "SAMPLING\n";
		
		// Aggiunge il periodo di campionamento
		stringToReturn2 += this.periods + "\n";
		
		// Aggiunge la clausola ON UNSUPPORTED SAMPLE RATE
		if(this.operation == null)
			stringToReturn2 += "<ON_UNSUPPORTED_SAMPLE_RATE>";
		else
			stringToReturn2 += "ON UNSUPPORTED SAMPLE RATE " + this.operation;
		stringToReturn2 += "\n";
		
		// Aggiunge la clausola REFRESH
		if(this.refreshClause == null)
			stringToReturn2 += "<REFRESH_CLAUSE>";
		else
			stringToReturn2 +=  this.refreshClause;
		stringToReturn2 += "\n";
		
		// Aggiunge la condizione WHERE
		if(this.getWhereClause() == null)
			stringToReturn2 += "<WHERE_CLAUSE>";
		else
			stringToReturn2 += this.getWhereClause();
		
		// Ritorna la stringa costruita
		return stringToReturn1 + Library.indentString(stringToReturn2, 1);
	}	
}
